/*******************************************************************************
* Copyright (c) 2012-2014, The Microsystems Design Labratory (MDL)
* Department of Computer Science and Engineering, The Pennsylvania State University
* All rights reserved.
* 
* This source code is part of NVMain - A cycle accurate timing, bit accurate
* energy simulator for both volatile (e.g., DRAM) and non-volatile memory
* (e.g., PCRAM). The source code is free and you can redistribute and/or
* modify it by providing that the following conditions are met:
* 
*  1) Redistributions of source code must retain the above copyright notice,
*     this list of conditions and the following disclaimer.
* 
*  2) Redistributions in binary form must reproduce the above copyright notice,
*     this list of conditions and the following disclaimer in the documentation
*     and/or other materials provided with the distribution.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* 
* Author list: 
*   Matt Poremba    ( Email: mrp5060 at psu dot edu 
*                     Website: http://www.cse.psu.edu/~poremba/ )
*******************************************************************************/

#ifndef __GENERICTRACEWRITER_H__
#define __GENERICTRACEWRITER_H__

#include "traceReader/TraceLine.h"
#include "src/Config.h"

#include <string>
#include <vector>
#include <cstdlib>
#include <cassert>

namespace NVM {

class GenericTraceWriter
{
  public:
    GenericTraceWriter( );
    virtual ~GenericTraceWriter( );

    virtual void Init( Config *conf );

    virtual void SetTraceFile( std::string file ) = 0;
    virtual std::string GetTraceFile( ) = 0;

    virtual void SetEcho( bool echo ); 
    virtual bool GetEcho( );

    virtual void SetPerChannelTraces( bool perChannel );
    virtual void SetPerRankTraces( bool perRank );

    virtual bool GetPerChannelTraces( );
    virtual bool GetPerRankTraces( );

    virtual bool SetNextAccess( TraceLine *nextAccess ) = 0;
    virtual int  SetNextNAccesses( unsigned int N, 
                                   std::vector<TraceLine *> *nextAccesses );

  private:
    bool echo_on;
    bool perChannel;
    bool perRank;

};

};

#endif
